<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SA-PCB: load_bookshelf Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SA-PCB
   </div>
   <div id="projectbrief">Annealing-basedPCBplacementtool</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">load_bookshelf Namespace Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af362b6e78cd6c21a61e7121004012427"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#af362b6e78cd6c21a61e7121004012427">read_pl</a> (fname)</td></tr>
<tr class="separator:af362b6e78cd6c21a61e7121004012427"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0ed046ff5f06efeeaf635f62102b461"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#ab0ed046ff5f06efeeaf635f62102b461">read_pl2</a> (fname, components)</td></tr>
<tr class="separator:ab0ed046ff5f06efeeaf635f62102b461"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8cfa7c1af71aaec08e6d6b3f8980448d"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#a8cfa7c1af71aaec08e6d6b3f8980448d">read_nets</a> (fname, components, board_pins)</td></tr>
<tr class="separator:a8cfa7c1af71aaec08e6d6b3f8980448d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1bd13159eab6dca26b88b86629e134b"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#af1bd13159eab6dca26b88b86629e134b">read_nets2</a> (fname, components, board_pins)</td></tr>
<tr class="separator:af1bd13159eab6dca26b88b86629e134b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a6d568e82b7e2dba02198302060646c"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#a4a6d568e82b7e2dba02198302060646c">read_blocks</a> (fname)</td></tr>
<tr class="separator:a4a6d568e82b7e2dba02198302060646c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a082905057f2a5d9b7354606e03546c62"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#a082905057f2a5d9b7354606e03546c62">read_shapes</a> (fname, components)</td></tr>
<tr class="separator:a082905057f2a5d9b7354606e03546c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6206547e6ee76abd5eb80e0167922867"><td class="memItemLeft" align="right" valign="top">def&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceload__bookshelf.html#a6206547e6ee76abd5eb80e0167922867">read_nodes</a> (fname)</td></tr>
<tr class="separator:a6206547e6ee76abd5eb80e0167922867"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65ffd43c081e1cc770d6980151dd3cec"><td class="memItemLeft" align="right" valign="top"><a id="a65ffd43c081e1cc770d6980151dd3cec"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>write_pl</b> (fname, components, board_pins)</td></tr>
<tr class="separator:a65ffd43c081e1cc770d6980151dd3cec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1725c1222c9f5804ddd209bc390ec53e"><td class="memItemLeft" align="right" valign="top"><a id="a1725c1222c9f5804ddd209bc390ec53e"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>write_nodes</b> (fname, components, board_pins)</td></tr>
<tr class="separator:a1725c1222c9f5804ddd209bc390ec53e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c12f5788c4500f6faa0f753c63f84e8"><td class="memItemLeft" align="right" valign="top"><a id="a8c12f5788c4500f6faa0f753c63f84e8"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>write_newnets</b> (fname, nets, components)</td></tr>
<tr class="separator:a8c12f5788c4500f6faa0f753c63f84e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae51de68114f96e0977ef479d41d86ff3"><td class="memItemLeft" align="right" valign="top"><a id="ae51de68114f96e0977ef479d41d86ff3"></a>
def&#160;</td><td class="memItemRight" valign="bottom"><b>write_newpl</b> (fname, components, board_pins)</td></tr>
<tr class="separator:ae51de68114f96e0977ef479d41d86ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><pre class="fragment">///////////////////////////////////////////////////////////////////////////////
// Authors: Chester Holtz, Devon Merrill, James (Ting-Chou) Lin, Connie (Yen-Yi) Wu
//          (respective Ph.D. advisors: Chung-Kuan Cheng, Andrew B. Kahng, Steven Swanson).
//
// BSD 3-Clause License
//
// Copyright (c) 2018, The Regents of the University of California
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
//   list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// * Neither the name of the copyright holder nor the names of its
//   contributors may be used to endorse or promote products derived from
//   this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
///////////////////////////////////////////////////////////////////////////////
</pre> </div><h2 class="groupheader">Function Documentation</h2>
<a id="a4a6d568e82b7e2dba02198302060646c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a6d568e82b7e2dba02198302060646c">&#9670;&nbsp;</a></span>read_blocks()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_blocks </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .blocks file
:param fname: .blocks filename
</pre> 
</div>
</div>
<a id="a8cfa7c1af71aaec08e6d6b3f8980448d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cfa7c1af71aaec08e6d6b3f8980448d">&#9670;&nbsp;</a></span>read_nets()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_nets </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>components</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>board_pins</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .nets (netlist) file
:param fname: .nets filename
</pre> 
</div>
</div>
<a id="af1bd13159eab6dca26b88b86629e134b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af1bd13159eab6dca26b88b86629e134b">&#9670;&nbsp;</a></span>read_nets2()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_nets2 </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>components</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>board_pins</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .nets (netlist) file
:param fname: .nets filename
</pre> 
</div>
</div>
<a id="a6206547e6ee76abd5eb80e0167922867"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6206547e6ee76abd5eb80e0167922867">&#9670;&nbsp;</a></span>read_nodes()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_nodes </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .nodes (blocks) file
:param fname: .nodes filename
</pre> 
</div>
</div>
<a id="af362b6e78cd6c21a61e7121004012427"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af362b6e78cd6c21a61e7121004012427">&#9670;&nbsp;</a></span>read_pl()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_pl </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .pl (placement) file
:param fname: .pl filename
</pre> 
</div>
</div>
<a id="ab0ed046ff5f06efeeaf635f62102b461"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0ed046ff5f06efeeaf635f62102b461">&#9670;&nbsp;</a></span>read_pl2()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_pl2 </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>components</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .pl (placement) file
:param fname: .pl filename
</pre> 
</div>
</div>
<a id="a082905057f2a5d9b7354606e03546c62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a082905057f2a5d9b7354606e03546c62">&#9670;&nbsp;</a></span>read_shapes()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">def load_bookshelf.read_shapes </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>fname</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>components</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<pre class="fragment">Read &amp; parse .shapes (shapes) file
:param fname: .shapes filename
</pre> 
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>
